Перейти к основному содержимому

Спецификация API

Swagger - https://app.swaggerhub.com/apis/insur/name

Для ФЛ методы individual, для ЮЛ – corporate.

Адрес сервера: Stage: https://services-stg.vsk.ru/ship/biz/

Prod: https://services.vsk.ru/ship/biz/

Авторизация:​

Авторизация происходит с помощью метода POST https://services-stg.vsk.ru/ship/token

Где в body необходимо передать:

  • client_id = выдает СК при получении доступа к сервису
  • client_secret = выдает СК при получении доступа к сервису
  • grant_type = client_credentials (передавать всегда)

Общий сценарий работы для ФЛ и ЮЛ​

Для формирования запроса в зависимости от типа страхователя, необходимо {{тип запроса}} в сценарии заменить на значение:

  1. Аутентификация, согласно описанию: https://developers.vsk.ru/docs/auth/. Получение токена доступа для вызова методов.

  2. Предварительный расчет стоимости договора (POST {{server}}/sales/v2/{{тип запроса}}/casco/quotes). Быстрый расчет премии по договору. Премия на предварительном расчете будет соответствовать премии при создании договора, только если передавать те же данные, которые будут передаваться при создании договора.

  3. Создание проекта договора, итоговый расчет стоимости договора (POST {{server}}/sales/v2/{{тип запроса}}/casco/policies). Сохраняется проект договора, присваивается номер. В зависимости от статуса договора, который вернется при создании договора, выявляется требование андеррайтинга. Если статус договора, в блоке status.code = WAITING_PAYMENT, то договор не требует андеррайтинга, можно переходить к пункту 7 сценария. Клиенту будет направлен на указанный в договоре e-mail ПФ черновика полиса и КИД. Если статус договора, в блоке status.code = UW_VIEW, то по договору требуется андеррайтинг, переходим к пункту 5.

  4. Обновление ранее созданного договора возможно методом (PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}.) В зависимости от статуса договора, который вернется при обновлении договора, выявляется требование андеррайтинга. Если статус договора, в блоке status.code = WAITING_PAYMENT, то договор не требует андеррайтинга, можно переходить к пункту 7 сценария. Если статус договора, в блоке status.code = UW_VIEW, то по договору требуется андеррайтинг, переходим к пункту 5.

  5. При получении статуса договора UW_VIEW, договор необходимо направить договор на осмотр Т.С. На текущий момент реализовано два вида осмотров:

5.1 Осмотр клиентом через мобильное приложение «ВСК Страхование», для активации данного типа осмотра, необходимо направить метод PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/uw/status

5.2 Осмотр агентом:

5.2.1 Агенту необходимо загрузить обязательные документы и фото для осмотра методом POST {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files

5.2.2 После успешной загрузки документов, необходимо направить договор на осмотр методом PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/uw/status

  1. Проверить статус андеррайтинга необходимо методом GET {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/uw/status, статус вернется в блоке: code Существует несколько статусов договора, после направления на андеррайтинг:

6.1 UW_DOCUMENTS_REQUIRED: Требуются дополнительные документы.

6.1.1 Прочитать какие требуются документы, можно запросив полис методом GET {{server}}/sales/v2/policies/{{policy_nr}} в блоке: policy.uw.status.comment

6.1.2 Загрузку необходимых документов произвести методом POST {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files

6.1.3 Обновить договор методом PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}

6.1.4 Направить договор на повторный андеррайтинг методом PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/uw/status

6.2 UW_FINALIZED: Отказ от андерайтера, процесс работы с договором завершен.

6.2.1 Прочитать причину отказа, можно запросив полис методом GET {{server}}/sales/v2/policies/{{policy_nr}} в блоке: policy.uw.status.comment

6.3 UW_REFUSED: Требуется доработать договор.

6.3.1 Прочитать какие требуются доработки, можно запросив полис методом GET {{server}}/sales/v2/policies/{{policy_nr}} в блоке: policy.uw.status.comment

6.3.2 Если требуется загрузка документов, то произвести методом POST {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files

6.3.3 Обновить договор, согласно требований андеррайтера, методом PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}

6.4 UW_APPROVED: Осмотр пройден успешно. Промежуточный статус, автоматически меняется на статус WAITING_PAYMENT в течении 1-2 минут.

6.5 WAITING_PAYMENT: Договор готов к оплате. Клиенту будет направлен на указанный в договоре e-mail ПФ черновика полиса и КИД.

6.6 UW_VIEW: Договор находится на андеррайтинге/требуется андеррайтинг

  1. Для получения печатной формы документа из полиса, необходимо

7.1 Запросить список доступных документов в полисе методом GET {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files, тип документа будет указан в блоке files.fileTypeCode

7.2 Получить конкретный файл из полиса методом методом GET {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files/{{Id файла из списка доступных файлов в блоке files. fileId}}. Файл придет в формате base64, который нужно будет перекодировать в ПДФ.

  1. Оплата договора производится методом PUT {{server}}/sales/v2/{{тип запроса}}/casco/policies/installments//{{Id платежа}}. Id платежа можно получить несколькими способами:

8.1 При создании/обновлении договора взять нужный id платежа из ответа на запрос в блоке: installments.[].id

8.2 Получить данные по договору методом GET {{server}}/sales/v2/policies/{{policy_nr}} id платежа вернется в блоке policy. installments.[].id

  1. Проверка статуса оплаты методом GET {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/uw/status, статус вернется в блоке: code Существует несколько статусов полиса на этапе оплаты:

9.1. WAITING_PAYMENT: Договор ожидает оплаты

9.2 IN_PAYMENT: Сформирована ссылка на оплату/счет на оплату договора и ожидается оплата

9.3 PAID: Договор оплачен. Финальный статус, доступна печатная форма действующего полиса. После произведения оплаты, клиенту на указанный в договоре e-mail будет направлен КИД и финальная печатная форма договора.

  1. Для получения финальной печатной формы документа из полиса, необходимо

10.1 Запросить список доступных документов в полисе методом GET {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files, тип документа будет указан в блоке files.fileTypeCode, тип документа финальной POLICY.

10.2 Получить конкретный файл из полиса методом методом GET {{server}}/sales/v2/{{тип запроса}}/casco/policies/{{policy_nr}}/files/{{Id файла из списка доступных файлов в блоке files. fileId}}. Файл придет в формате base64, который нужно будет перекодировать в ПДФ.

Для получения справочных значений используются отдельные методы: https://developers.vsk.ru/docs/products/casco/directory/

Методы возвращает все значения справочника, без деления на доступность для определенного продукта.

Запросить актуальную Postman коллекцию запросов к АПИ, можно на выделенном e-mail службы поддержки integr@vsk.ru

Статусная модель для ФЛ и ЮЛ​

Рисунок